home *** CD-ROM | disk | FTP | other *** search
/ Aminet 35 / Aminet 35 (2000)(Schatztruhe)[!][Feb 2000].iso / Aminet / dev / gui / gui4cli.lha / Gui4Cli / Tools / fastread / MakeDoc.doc < prev    next >
Encoding:
Text File  |  1999-11-17  |  2.7 KB  |  62 lines
  1.  
  2.                               MAKEDOC.GC
  3.                              ------------
  4.  
  5.      A guide assembler for use with the FastRead Help System.
  6.  
  7. Introduction
  8. ------------
  9. MakeDoc will join all specified files together into one file in the
  10. order specified, also adding the '@database' header and inserting the
  11. '@node' and '@endnode' lines where appropriate, making the document
  12. readable by AmigaGuide. This makes it easy to update any individual 
  13. node, and re compiling a new guide with MakeDoc.
  14.  
  15. The name of the specified target file will by default be used as the
  16. database title, and each inividual file name which is selected for
  17. joining will be used for its corresponding node title.
  18.  
  19. Requirements
  20. ------------
  21. MakeDoc needs the Type command in C: and Gui4Cli version 3.0 minimum.
  22.  
  23. Usage and the User Interface
  24. ----------------------------
  25. Apart from the buttons, the MakeDoc gui is composed mainly of two
  26. listviews. The left hand lister reads in the contents of the directory
  27. containing the files to be joined. The right hand lister holds the
  28. names of the files which have been selected in the left hand one.
  29. These are the files which will be operated on, and the right hand
  30. lister is the one which does the work.
  31.  
  32. At the top of the gui is the 'Outfile' button, with a string gadget
  33. next to it. These are for specifying the path and name of the target
  34. file. The target file can be specified by typing directly into the
  35. string gadget, and if a filename is typed in without a path, the
  36. target file will be created in the same directory as the source files.
  37. The Outfile button produces a file requester, and automatically
  38. inserts the full path and name of the target file. The joining
  39. operation cannot be started until a target file is specified by either
  40. of these two methods.
  41.  
  42. Over the top of the listers are all the buttons for file manipulation.
  43. Files from the left hand lister are transferred over to the right
  44. lister by first selecting them and then clicking on the 'Xfer' button.
  45. Single files can be transferred one at a time by double clicking on
  46. them in the left lister. 
  47.  
  48. Once in the right lister, the files can be arranged in any order by
  49. clicking on the filename in the lister and using the 'Up' and 'Down'
  50. buttons, or pressing the U and D keys. Individual files can be erased
  51. from the lister with the 'Remove' button, or the lister cleared at any
  52. time with the 'Clear' button.
  53.  
  54. When all the files are in the correct order for joining, and a target
  55. file has been specified, the 'Start' button will become active, and
  56. the operation may be started. Until a target file has been specified
  57. in the string gadget or by the 'Outfile' button, the Start button is
  58. ghosted. It will ghost again when the joining operation finishes, and
  59. the right lister and string gadget will clear.
  60.  
  61. gmaddox@netcentral.co.uk
  62.